/projects/{projectId}/classes (Get)

Get	/projects/{projectId}/classes

In This Topic

Description

returns the list of classes in a project

Parameters

Name	Description	Data Type
projectId	the id of the project to look in	string
skip	number of records to skip for pagination	integer (int32)
limit	maximum number of records to return	integer (int32)

200 Response

The response body is of type Array[scadaClass].

search results matching criteria

Array[scadaClass]

scadaClass

CIMPLICITY class definition

classId : string

the unique ID for this class

description : string

the description for this class

classVersion : integer

the version number for this class, incremented with each change made to the class

dataItems : Array[dataItem]

an array of the data items of this class

dataItemId : string

dataType : string

the CIMPLICITY data type for this data item

numElements : integer

description : string

the description of this data item

compositeMembers : Array[compositeMember]

an array of the child members of this class

memberId : string

the unique ID for this composite member of the class

classId : string

the ID of the child class this composite member is made from

description : string

the description of this composite member

Fault Responses

Fault	Description
404	This fault returns a response body of type ProblemDetails. project with the given id is not registered on the system

Remarks

By passing a registered project id you can get a list of classes in this project